Skip to main content
GET
/
v1
/
customers
/
credits
Get all credit products
curl --request GET \
  --url https://api.hyperline.co/v1/customers/credits \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "product_id": "itm_3kXODDF42QXtnL",
      "customer_id": "cus_Typ0px2W0aiEtl",
      "name": "Credit name",
      "current_balance": 2000,
      "low_count_threshold": 10,
      "last_refreshed_at": "2025-11-23T09:00:01.860Z",
      "auto_topup": {
        "credit_count": 32,
        "amount_excluding_tax": 123,
        "price_id": "<string>"
      },
      "created_at": "2025-10-12T07:00:01.860Z",
      "updated_at": "2025-10-13T10:00:01.860Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
product_id
string
product_id__not
string
product_id__isNull
string
product_id__isNotNull
string
product_id__equals
string
product_id__contains
string
product_id__startsWith
string
product_id__endWith
string
customer_id
string
customer_id__not
string
customer_id__isNull
string
customer_id__isNotNull
string
customer_id__equals
string
customer_id__contains
string
customer_id__startsWith
string
customer_id__endWith
string
updated_at
string<date-time>
updated_at__not
string<date-time>
updated_at__isNull
string<date-time>
updated_at__isNotNull
string<date-time>
updated_at__equals
string<date-time>
updated_at__lt
string<date-time>
updated_at__lte
string<date-time>
updated_at__gt
string<date-time>
updated_at__gte
string<date-time>

Response

200 - application/json
meta
object
required
data
object[]
required

List of Credit.

I